Api.EnableTouchProbe method

Adds the TouchProbeControl and TouchProbeStatus variables to PDO.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

public KsError EnableTouchProbe(
       bool Active
)

Public Function EnableTouchProbe(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true: The TouchProbeControl and TouchProbeStatus variables are mapped to PDO. false: Not mapped to PDO. By default, it is true.

Return value

Type: KsError

A return code of a method.

Remarks

This method must be called after Create and before Start.

Usable EtherCAT states

ecatOffline

Examples

N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace